/*
 * Copyright 2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.dailydev.wave.robot;

import java.util.Set;

import com.google.wave.api.Capability;
import com.google.wave.api.RobotMessageBundle;

/**
 * @author Roman Bosak, DailyDev.org
 */
public interface IRobot {

    /**
     * Returns {@link Set} of {@link Capability}. The set is used to generate
     * capabilities.xml file.
     * 
     * @return
     */
    Set<Capability> getCapabilities();

    /**
     * @return the robotVersion
     */
    String getRobotVersion();

    /**
     * @param bundle
     * @throws RobotException
     */
    void processEvents(RobotMessageBundle bundle) throws RobotException;

    /**
     * @return the robotName
     */
    public String getRobotName();

    /**
     * @return the robotAvatar
     */
    public String getRobotAvatar();

}